XIQS Create User

From IQsimWiki

Jump to: navigation, search

XIQS Create User - User Management

Description
createXIQSUser ( String login, String password, Long id_partition, Integer default_time_zone, String last_name, String first_name, String email_address, String user_language [, Integer ui_allowed] )
Create a new xiqs user in the specified partition.
Note: only administrator can create users in other partitions than current
Parameters

String login

Login name

String password

Login password

Long id_partition

User's partition Id

Integer default_time_zone

Timezone Id, see Timezone table

String last_name

User's last name

String first_name

User's first name

String email_address

User's email address

String user_language

User's language

[ Integer ui_allowed]

Flag which defines if user interface is allowed for this user
Return Values
Integer id_user - Id of created user

Error Data structure ( Error Management )

Possible failure code returns
*ERR_OBJ_NOT_FOUND (404) ERR_MSG_PART_NOT_FOUND
*ERR_UNAUTHORIZED (401) ERR_MSG_ADMIN_ONLY
*ERR_OBJECT_EXISTS (451)ERR_MSG_USR_NAME_FOUND
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
See Also

getXIQSUserList

updateXIQSUser

deleteXIQSUser

getXIQSUserPrefInfo

updateXIQSUserPrefInfo

clearXIQSUserPrefs

Example

[REQUEST]
<command tid="44bb7a5c-0a69-4602-89f0-52a92a90caa9" name="createXIQSUser">
  <param type="string">JB</param>
  <param type="string">007</param>
  <param type="long">1</param>
  <param type="integer">9</param>
  <param type="string">James</param>
  <param type="string">Bond</param>
  <param type="string">james.bond@mi6.uk</param>
  <param type="string">ENG</param>
  <param type="integer">1</param>
</command>

[ANSWER (OK)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="return" tid="44bb7a5c-0a69-4602-89f0-52a92a90caa9">
  <meta-data>
    <user-meta>
      <meta-value>
        <name>id</name>
        <pos>1</pos>
      </meta-value>
    </user-meta>
  </meta-data>
  <param type="long">9</param>
</event>

[ANSWER (Error)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="error">
  <meta-data>
    <meta-value>
      <name>err_code</name>
      <pos>1</pos>
    </meta-value>
    <meta-value>
      <name>err_desc</name>
      <pos>2</pos>
    </meta-value>
  </meta-data>
  <param type="integer">451</param>
  <param type="string"> err.user.update.name.exist(JB)</param>
</event>

Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List